Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix bug in 2D CEE HLLE Noncartesian flux #1719

Merged
merged 2 commits into from
Nov 10, 2023
Merged

Fix bug in 2D CEE HLLE Noncartesian flux #1719

merged 2 commits into from
Nov 10, 2023

Conversation

DanielDoehring
Copy link
Contributor

In #1692 there is unfortunately a bug.
The correct velocity magnitude to be used is found in the 3D version

Trixi.jl/src/equations/compressible_euler_3d.jl

Line 1431 in 276dc3c

v_roe_mag = v1_roe^2 + v2_roe^2 + v3_roe^2

and the 2D version is wrong:

Trixi.jl/src/equations/compressible_euler_2d.jl

Line 1354 in 276dc3c

v_roe_mag = (v1_roe * normal_direction[1])^2 + (v2_roe * normal_direction[2])^2

@DanielDoehring DanielDoehring added the bug Something isn't working label Nov 8, 2023
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 8, 2023

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

@DanielDoehring
Copy link
Contributor Author

Interestingly (and unfortunately) this was not detected by the consistency checks

Trixi.jl/test/test_unit.jl

Lines 908 to 916 in 276dc3c

normal_directions = [SVector(1.0, 0.0),
SVector(0.0, 1.0),
SVector(0.5, -0.5),
SVector(-1.2, 0.3)]
for normal_direction in normal_directions
@test flux_hlle(u, u, normal_direction, equations) ≈
flux(u, normal_direction, equations)
end

but instead by the rotation test added in #1708.

sloede
sloede approved these changes Nov 8, 2023
View reviewed changes
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch! Code LGTM, but it would be good to get a review from someone familiar with the HLLE flux.

ranocha
ranocha approved these changes Nov 8, 2023
View reviewed changes
Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@DanielDoehring
Copy link
Contributor Author

Nice catch! Code LGTM, but it would be good to get a review from someone familiar with the HLLE flux.

Credit goes to @ranocha for being strict about the test : #1708 (comment)

@codecov Codecov
Copy link

codecov bot commented Nov 8, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (276dc3c) 74.61% compared to head (a57f7f9) 83.00%.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1719      +/-   ##
==========================================
+ Coverage   74.61%   83.00%   +8.39%     
==========================================
  Files         431      431              
  Lines       34600    34665      +65     
==========================================
+ Hits        25815    28772    +2957     
+ Misses       8785     5893    -2892
Flag Coverage Δ
unittests 83.00% <100.00%> (+8.39%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/equations/compressible_euler_2d.jl 96.81% <100.00%> (+0.72%) ⬆️

... and 107 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@DanielDoehring DanielDoehring mentioned this pull request Nov 9, 2023
Merged
@ranocha ranocha merged commit 63c6258 into trixi-framework:main Nov 10, 2023
27 of 31 checks passed
@DanielDoehring DanielDoehring deleted the FixBugHLLE_2D_CEE_NonCartesian branch November 10, 2023 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ranocha ranocha ranocha approved these changes

@sloede sloede sloede approved these changes

Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@DanielDoehring @sloede @ranocha